Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] [1/N] Reorganize Getting Started section #11645

Merged
merged 4 commits into from
Jan 6, 2025
Merged

[Doc] [1/N] Reorganize Getting Started section #11645

merged 4 commits into from
Jan 6, 2025

Conversation

DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Dec 31, 2024 •
edited by github-actions bot
Loading

  • The installation guide for each hardware platform is now nested under Installation to conserve space in the navigation tab.
    • Renamed basic installation guide to CUDA to be more explicit about the hardware platform.
    • Renamed CPU installation guide to x86 CPU in order to distinguish it from ARM CPUs.
  • Renamed Debugging Tips to Troubleshooting.
  • Moved FAQ from Usage section to Getting Started for better visibility.
  • Replaced some relative links with project references to avoid issues when moving pages in later PRs.

@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Dec 31, 2024
@DarkLight1337
Update headers
407f5b2 
Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337
Reorder navbar
b8a7b04 
Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337
Update link
7686f35 
Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337 DarkLight1337 force-pushed the reorganize-docs-getting-started branch from b15d7cf to 7686f35 Compare December 31, 2024 05:47
@DarkLight1337 DarkLight1337 marked this pull request as ready for review December 31, 2024 05:49
@DarkLight1337 DarkLight1337 changed the title [Doc] Reorganize Getting Started section [Doc] 1/N] Reorganize Getting Started section Dec 31, 2024
@DarkLight1337 DarkLight1337 changed the title [Doc] 1/N] Reorganize Getting Started section [Doc] [1/N] Reorganize Getting Started section Dec 31, 2024
@DarkLight1337
Copy link
Member Author

I have already set up the redirects, feel free to merge once you approve it.

youkaichao
youkaichao approved these changes Jan 5, 2025
View reviewed changes
Copy link
Member

@youkaichao youkaichao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the great work!

@youkaichao youkaichao enabled auto-merge (squash) January 5, 2025 14:13
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jan 5, 2025
@youkaichao youkaichao merged commit 402d378 into vllm-project:main Jan 6, 2025
79 checks passed
@DarkLight1337 DarkLight1337 deleted the reorganize-docs-getting-started branch January 6, 2025 02:18
@yansh97
Copy link
Contributor

yansh97 commented Jan 6, 2025

Does the "Examples" section provide grouping? At present, there are a lot of example pages, which seems a bit inconvenient.

@DarkLight1337
Copy link
Member Author

DarkLight1337 commented Jan 6, 2025 •
edited
Loading

Does the "Examples" section provide grouping? At present, there are a lot of example pages, which seems a bit inconvenient.

No, let's revisit that in another PR.

@hmellor hmellor mentioned this pull request Jan 6, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@youkaichao youkaichao youkaichao approved these changes

@simon-mo simon-mo Awaiting requested review from simon-mo

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DarkLight1337 @yansh97 @youkaichao